Transforms forPromptObject


PromptHierarchicalTreeXHTMLTransform

Formal Parameter Type Default Required Description
attrFormTypeInAvailableList INTEGER 2 false Specifies what attribute forms are to be displayed.
This formal parameter will only three possible values defined in CartExpression interface:
  • CartExpression.DISPLAY_ONLY_ATTR_ID_FORMS indicates only display ID forms and ignore other forms when displaying.
  • CartExpression.DISPLAY_ATTR_NON_ID_FORMS indicates to ignore ID forms and display all other type of forms.
  • CartExpression.DISPLAY_ALL_ATTR_FORMS indicates to display both ID and Non-Id forms (default behavior).
attrSearchRequired BOOLEAN false false  
attributeImage STRING treeAttribute.gif false Image used to represent an attribute.
attributeLockedImage STRING treeAttributeLocked.gif false Image used to represent a locked attribute.
availableSize INTEGER 10 false The number of elements that the Available list box displays.
This flag is used as an int value.
backToTop STRING BackToTop.gif false

Deprecated. This formal parameter is no longer used. There are no references to this formal parameter in the code
calendarImage STRING calendar.gif false  
cssPrefix STRING   false Prefix to append to all css class names.
defaultOperatorId STRING   false Specifies operator Id to be used as default in expression.
If this value is set to empty string, then original behavior will be adopted.
Default value is empty string.
Possible values are any constant defined in EnumDSSXMLFunction enumeration which is supported by any style of Expression prompts.
editMetricQualificationOutputLevel BOOLEAN true false Specifies whether or not the output level of a metric qualification is editable.
If this value is set to true, a button to open and edit the output level is shown.
This flag is used as a boolean value
Default value is true.
elementImage STRING treeAttributeElement.gif false Image used to represent an attribute element.
errorImage STRING promptError_white.gif false  
folderImage STRING treeFolderClosed.gif false Image used to represent a folder.
folderItemsInTree BOOLEAN true false Specifies whether folder items should be displayed or not.
hierarchiesInTree BOOLEAN false false Specifies whether the hierarchies will be displayed inside the tree.
hierarchyImage STRING hierarchy.png false Image used to represent a hierarchy.
isQualifyAvailable BOOLEAN false false Indicates if qualification pane is available.
levelFlag INTEGER 4095 false Specifies what fields in prompt question are displayed.
Prompt question is broken down in four visible fields: title, meaning, restriction and content. Multiple fields can be displayed at the same time. Which fields to be displayed is indicated by a bit-wise flag.
This flag is used as bit-wise value.
Allowed Values:
  • Title = LEVEL_SHOW_TITLE
  • Meaning = LEVEL_SHOW_MEANING
  • Restriction = LEVEL_SHOW_RESTRICTION
  • Content = LEVEL_SHOW_CONTENT
  • Back to Top = LEVEL_SHOW_TITLE_BACKTOTOP
  • Show all = LEVEL_SHOW_ALL

For complete list, refer to EnumPromptLevelFlags
Usage:
For example, if you want to specify name and owner, then you would specify (1 + 4 = 5) Default value is LEVEL_SHOW_ALL
loadFileSeparator STRING ; false Specifies separator to be used when parsing uploaded file values.
logicalOperatorAvailableUserDefined BOOLEAN true false Specifies a custome boolean value indicating whether or not to displaye logical operators.
logicalOperatorDefault INTEGER 19 false Specifies 'And/Or' match case default value. The value for this formal parameter comes from the EnumDSSXMLFunction enumeration.
logicalOperatorSelectionMethod INTEGER 2 false Specifies whether the 'And/Or' match case checkbox is displayed or not next the selected list in cart style ouput.
matchCase BOOLEAN false false Specifies whether the match case checkbox is displayed or not next to a search section.
Indicates whether or not to show match case checkbox next to search section. Not all prompt types support searching for elements, so even if this parameter is true, the search box might not be available.
This flag is used as a boolean value.
searchAvailable BOOLEAN true false Specifies whether the transform should display a search section.
Not all prompt types support searching for elements, so even if this parameter is true, the search box might not be available.
This flag is used as a boolean value.
searchSize INTEGER 12 false Specifies the size of the search text box.
selectedSelectSize INTEGER 10 false  
showAttributeSelection BOOLEAN true false Specifies whether or not to show or hide the Attribute Selection dropdown for hierarchical prompts.
This flag is used as a boolean value.
showEntryPointSelectBox BOOLEAN true false Specifies whether or not to show the entry point select box for hierarchical prompts.
This flag is used as a boolean value.
showRequired BOOLEAN true false Specifies whether or not to display 'Required' message at the end of prompt title.
'Required' message is static and it's displayed along with prompt title. This message can be either displayed or not.
This flag is used as boolean value.
treeStyle STRING   false Class to indicate the style to use when displaying the tree.
truncateExpressionDisplay INTEGER 100 false  
truncateUploadedAnswersDisplay BOOLEAN false false Specifies whether or not to truncate selected list output to certain number of characters.
This formal parameter will be ignored if uploading answers isn't enabled. Default value indicates not to truncate.